Class Objects.Sink
Represents a sink object.
Functions
| Sink:GetName() | Get this sink's unique string identifier. |
| Sink:GetPosition() | Get this sink's world position. |
| Sink:GetStrength() | Get this sink's strength. |
| Sink:SetName(name) | Set this sink's unique string identifier. |
| Sink:SetPosition(pos) | Set this sink's world position. |
| Sink:SetStrength(strength) | Set this sink's strength. |
Functions
- Sink:GetName()
-
Get this sink's unique string identifier.
Returns:
-
string
Name.
- Sink:GetPosition()
-
Get this sink's world position.
Returns:
-
Vec3
World position.
- Sink:GetStrength()
-
Get this sink's strength.
Returns:
-
int
Strength.
- Sink:SetName(name)
-
Set this sink's unique string identifier.
Parameters:
- name string New name.
- Sink:SetPosition(pos)
-
Set this sink's world position.
Parameters:
- pos Vec3 New world position.
- Sink:SetStrength(strength)
-
Set this sink's strength.
Higher numbers provide stronger currents. Clamped to the range [1, 32].
Parameters:
- strength int New strength.